home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / string / RCS / string.man,v < prev    next >
Encoding:
Text File  |  1991-04-13  |  5.3 KB  |  228 lines
  1. head     1.4;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.4
  10. date     91.04.12.19.44.15;  author kupfer;  state Exp;
  11. branches ;
  12. next     1.3;
  13.  
  14. 1.3
  15. date     89.01.09.10.22.23;  author ouster;  state Exp;
  16. branches ;
  17. next     1.2;
  18.  
  19. 1.2
  20. date     88.12.30.15.49.47;  author ouster;  state Exp;
  21. branches ;
  22. next     1.1;
  23.  
  24. 1.1
  25. date     88.12.30.15.49.25;  author ouster;  state Exp;
  26. branches ;
  27. next     ;
  28.  
  29.  
  30. desc
  31. @@
  32.  
  33.  
  34. 1.4
  35. log
  36. @Add strdup().
  37. @
  38. text
  39. @.\" Copyright (c) 1980 Regents of the University of California.
  40. .\" All rights reserved.  The Berkeley software License Agreement
  41. .\" specifies the terms and conditions for redistribution.
  42. .\"
  43. .\"    @@(#)string.3    6.5 (Berkeley) 10/22/87
  44. .\" $Header$
  45. .\"
  46. .TH STRING 3  "April 12, 1991"
  47. .UC 4
  48. .SH NAME
  49. strcat, strncat, strcmp, strncmp, strcasecmp, strncasecmp, strcpy,
  50. strncpy, strdup, strlen, strchr, index, strrchr, rindex, strstr,
  51. strspn, strcspn, strpbrk \- string operations
  52. .SH SYNOPSIS
  53. .nf
  54. .B #include <string.h>
  55. .PP
  56. .B char *strcat(s, append)
  57. .B char *s, *append;
  58. .PP
  59. .B char *strncat(s, append, count)
  60. .B char *s, *append;
  61. .B int count;
  62. .PP
  63. .B strcmp(s1, s2)
  64. .B char *s1, *s2;
  65. .PP
  66. .B strncmp(s1, s2, count)
  67. .B char *s1, *s2;
  68. .B int count;
  69. .PP
  70. .B strcasecmp(s1, s2)
  71. .B char *s1, *s2;
  72. .PP
  73. .B strncasecmp(s1, s2, count)
  74. .B char *s1, *s2;
  75. .B int count;
  76. .PP
  77. .B char *strcpy(to, from)
  78. .B char *to, *from;
  79. .PP
  80. .B char *strncpy(to, from, count)
  81. .B char *to, *from;
  82. .B int count;
  83. .PP
  84. .B char *strdup(s)
  85. .B char *s;
  86. .PP
  87. .B strlen(s)
  88. .B char *s;
  89. .PP
  90. .B char *strchr(s, c)
  91. .B char *s;
  92. .B int c;
  93. .PP
  94. .B char *index(s, c)
  95. .B char *s, c;
  96. .PP
  97. .B char *strrchr(s, c)
  98. .B char *s;
  99. .B int c;
  100. .PP
  101. .B char *rindex(s, c)
  102. .B char *s, c;
  103. .PP
  104. .B char *strstr(s, s2)
  105. .B char *s, *s2;
  106. .PP
  107. .B int strspn(s, s2)
  108. .B char *s, *s2;
  109. .PP
  110. .B int strcspn(s, s2)
  111. .B char *s, *s2;
  112. .PP
  113. .B char *strpbrk(s, s2)
  114. .B char *s, *s2;
  115. .fi
  116. .SH DESCRIPTION
  117. These functions operate on null-terminated strings.
  118. They do not check for overflow of any receiving string.
  119. .PP
  120. \fIStrcat\fP appends a copy of string \fIappend\fP to the end of string
  121. \fIs\fP. \fIStrncat\fP copies at most \fIcount\fP characters.  Both
  122. return a pointer to the null-terminated result.
  123. .PP
  124. \fIStrcmp\fP compares its arguments and returns an integer greater than,
  125. equal to, or less than 0, according as \fIs1\fP is lexicographically
  126. greater than, equal to, or less than \fIs2\fP.  \fIStrncmp\fP makes the
  127. same comparison but looks at at most \fIcount\fP characters.
  128. \fIStrcasecmp\fP and \fIstrncasecmp\fP are identical in function, but are
  129. case insensitive.  The returned lexicographic difference reflects a
  130. conversion to lower-case.
  131. .PP
  132. \fIStrcpy\fP copies string \fIfrom\fP to \fIto\fP, stopping after the
  133. null character has been moved.  \fIStrncpy\fP copies exactly \fIcount\fP
  134. characters, appending nulls if \fIfrom\fP is less than \fIcount\fP
  135. characters in length; the target may not be null-terminated if the
  136. length of \fIfrom\fP is \fIcount\fP or more.  Both return \fIto\fP.
  137. .PP
  138. \fIStrdup\fP allocates storage for a copy of \fIs\fP, copies
  139. \fIs\fP into it, and returns the copied string.  The copy may be freed
  140. by calling 
  141. .IR free (3).
  142. .PP
  143. \fIStrlen\fP returns the number of non-null characters in \fIs\fP.
  144. .PP
  145. \fIStrchr\fR and \fIindex\fR both return pointers to the first occurrence
  146. of character \fIc\fR in string \fIs\fR or \fBNULL\fR if \fIc\fR does not
  147. occur in the string.  The two procedures are identical except for their
  148. names and the argument \fIc\fR, which is an \fBint\fR in \fIstrchr\fR and
  149. a \fBchar\fR in \fIindex\fR.  With the ANSI C standard, \fIindex\fR is
  150. becoming obsolete.
  151. .PP
  152. \fIStrrchr\fR and \fIrindex\fR are identical to \fIstrchr\fR and
  153. \fIindex\fR except that the return the address of the last occurrence
  154. of \fIc\fR instead of the first.  \fIRindex\fR is also becoming
  155. obsolete.
  156. .PP
  157. \fIStrstr\fR locates the first occurrence in the string pointed to by
  158. \fIs\fR of the sequence of characters (not including the terminating
  159. null character) in the string pointed to by \fIs2\fR.  If a match is
  160. found, the return value is the address of the first character in the
  161. matching substring.  Otherwise, \fBNULL\fR is returned.  If \fIs2\fR points
  162. to a string with zero length, then \fIs\fR is returned.
  163. .PP
  164. \fIStrspn\fR returns the length of the longest initial segment of
  165. \fIs\fR that consists entirely of characters from the string pointed
  166. to by \fIs2\fR.  \fIStrcspn\fR returns the length of the longest 
  167. initial segment of \fIs\fR that consists entirely of characters not
  168. in the string pointed to by \fIs2\fR.
  169. .PP
  170. \fIStrpbrk\fR returns the address of the first character in the
  171. string pointed to by \fIs\fR of any character in the string pointed to
  172. by \fIs2\fR.  If no character from \fIs2\fR occurs in \fIs1\fR, then
  173. \fBNULL\fR is returned.
  174.  
  175. .SH KEYWORDS
  176. compare, copy, string
  177. @
  178.  
  179.  
  180. 1.3
  181. log
  182. @Document additional procedures:  strspn, strcspn, strchr, strrchr, strstr,
  183. strpbrk.
  184. @
  185. text
  186. @d6 1
  187. d8 1
  188. a8 1
  189. .TH STRING 3  "October 22, 1987"
  190. d12 1
  191. a12 1
  192. strncpy, strlen, strchr, index, strrchr, rindex, strstr,
  193. d46 3
  194. d99 5
  195. @
  196.  
  197.  
  198. 1.2
  199. log
  200. @Switch include file name.
  201. @
  202. text
  203. @d11 2
  204. a12 1
  205. strncpy, strlen, index, rindex \- string operations
  206. d48 4
  207. d55 4
  208. d61 12
  209. d98 32
  210. a129 5
  211. .I Index
  212. .RI ( rindex )
  213. returns a pointer to the first (last) occurrence of character 
  214. \fIc\fP in string \fIs\fP or zero if \fIc\fP does not occur in
  215. the string.  Setting \fIc\fP to NULL works.
  216. @
  217.  
  218.  
  219. 1.1
  220. log
  221. @Initial revision
  222. @
  223. text
  224. @d14 1
  225. a14 1
  226. .B #include <strings.h>
  227. @
  228.